#region License
/*  Pvax.Utils
    Copyright (c) 2006, Alexey A. Popov
    All rights reserved.

    Redistribution and use in source and binary forms, with or without modification, are
    permitted provided that the following conditions are met:

    - Redistributions of source code must retain the above copyright notice, this list
      of conditions and the following disclaimer.

    - Redistributions in binary form must reproduce the above copyright notice, this list
      of conditions and the following disclaimer in the documentation and/or other materials
      provided with the distribution.

    - Neither the name of the Alexey A. Popov nor the names of its contributors may be used to
      endorse or promote products derived from this software without specific prior written
      permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *AS IS* AND ANY EXPRESS
    OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
    AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
    IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
    OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#endregion

using System;

namespace Pvax.Utils
{
	/// <summary>
	/// Description of IAsyncProcess.
	/// </summary>
	public interface IAsyncOp
	{
		/// <summary>
		/// Occures when the asynchronous operation is complete.
		/// </summary>
		event EventHandler Completed;
		
		/// <summary>
		/// Occures when the asynchronous operation is canceled.
		/// </summary>
		event EventHandler Canceled;
		
		/// <summary>
		/// Occures when the asyncronous operation is failed.
		/// </summary>
		event Pvax.Utils.Events.ExceptionEventHandler Failed;
		
		/// <summary>
		/// Cancel the asynchronous operation.
		/// </summary>
		/// <returns>
		/// <c>true</c> if operation can be canceled; <c>false</c> if not.
		/// </returns>
		/// <remarks>
		/// Some asynchronous operations cannot be cancelled, in such a case 
		/// the method returns <c>false</c>. However, if the operation supports 
		/// cancelation, this method succeedes and <see cref="Canceled"/> event 
		/// gets fired, may be with a delay.
		/// </remarks>
		bool Cancel();
	}
}
